<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Aether.Physics2D: FixedMouseJoint Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NugetLogo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aether.Physics2D
   &#160;<span id="projectnumber">2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">FixedMouseJoint Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A mouse joint is used to make a point on a body track a specified world point. This a soft constraint with a maximum force. This allows the constraint to stretch and without applying huge forces. NOTE: this joint is not documented in the manual because it was developed to be used in the testbed. If you want to learn how to use the mouse joint, look at the testbed.  
 <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for FixedMouseJoint:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint__inherit__graph.svg" width="152" height="118"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for FixedMouseJoint:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint__coll__graph.svg" width="330" height="252"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae8f3ac497907a3b49f3a048f7573f5c5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#ae8f3ac497907a3b49f3a048f7573f5c5">FixedMouseJoint</a> (<a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_body.html">Body</a> body, <a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a> worldAnchor)</td></tr>
<tr class="memdesc:ae8f3ac497907a3b49f3a048f7573f5c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This requires a world target point, tuning parameters, and the time step.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#ae8f3ac497907a3b49f3a048f7573f5c5">More...</a><br /></td></tr>
<tr class="separator:ae8f3ac497907a3b49f3a048f7573f5c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a655b5ba70f47995fbe17b62474d32ca7"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#a655b5ba70f47995fbe17b62474d32ca7">GetReactionForce</a> (float invDt)</td></tr>
<tr class="memdesc:a655b5ba70f47995fbe17b62474d32ca7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the reaction force on body at the joint anchor in Newtons.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#a655b5ba70f47995fbe17b62474d32ca7">More...</a><br /></td></tr>
<tr class="separator:a655b5ba70f47995fbe17b62474d32ca7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86cd32ec6a920205da5cf3202ceefba5"><td class="memItemLeft" align="right" valign="top">override float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#a86cd32ec6a920205da5cf3202ceefba5">GetReactionTorque</a> (float invDt)</td></tr>
<tr class="memdesc:a86cd32ec6a920205da5cf3202ceefba5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the reaction torque on the body at the joint anchor in N*m.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#a86cd32ec6a920205da5cf3202ceefba5">More...</a><br /></td></tr>
<tr class="separator:a86cd32ec6a920205da5cf3202ceefba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html">Joint</a></td></tr>
<tr class="memitem:ac1592acfb27fbe442c5fcdd3de9d093a inherit pub_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#ac1592acfb27fbe442c5fcdd3de9d093a">IsFixedType</a> ()</td></tr>
<tr class="memdesc:ac1592acfb27fbe442c5fcdd3de9d093a inherit pub_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if the joint is a fixed type.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#ac1592acfb27fbe442c5fcdd3de9d093a">More...</a><br /></td></tr>
<tr class="separator:ac1592acfb27fbe442c5fcdd3de9d093a inherit pub_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:aea4a215e75a513da8aae15b39eb44afe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#aea4a215e75a513da8aae15b39eb44afe">LocalAnchorA</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aea4a215e75a513da8aae15b39eb44afe"><td class="mdescLeft">&#160;</td><td class="mdescRight">The local anchor point on BodyA  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#aea4a215e75a513da8aae15b39eb44afe">More...</a><br /></td></tr>
<tr class="separator:aea4a215e75a513da8aae15b39eb44afe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e682b2efa30bbb78be0e028ca6ae828"><td class="memItemLeft" align="right" valign="top"><a id="a1e682b2efa30bbb78be0e028ca6ae828"></a>
override <a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><b>WorldAnchorA</b><code> [get, set]</code></td></tr>
<tr class="separator:a1e682b2efa30bbb78be0e028ca6ae828"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe947008abce0cb278427c6caa60bc74"><td class="memItemLeft" align="right" valign="top"><a id="afe947008abce0cb278427c6caa60bc74"></a>
override <a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><b>WorldAnchorB</b><code> [get, set]</code></td></tr>
<tr class="separator:afe947008abce0cb278427c6caa60bc74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea6a8bd745d298d7f57f809ccc4edadb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#aea6a8bd745d298d7f57f809ccc4edadb">MaxForce</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aea6a8bd745d298d7f57f809ccc4edadb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum constraint force that can be exerted to move the candidate body. Usually you will express as some multiple of the weight (multiplier * mass * gravity).  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#aea6a8bd745d298d7f57f809ccc4edadb">More...</a><br /></td></tr>
<tr class="separator:aea6a8bd745d298d7f57f809ccc4edadb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d3c19e881c80a6596884ecb8da4a0f4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#a9d3c19e881c80a6596884ecb8da4a0f4">Frequency</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a9d3c19e881c80a6596884ecb8da4a0f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The response speed.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#a9d3c19e881c80a6596884ecb8da4a0f4">More...</a><br /></td></tr>
<tr class="separator:a9d3c19e881c80a6596884ecb8da4a0f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f2ba932f90e63270ba804dd6337a8b0"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#a9f2ba932f90e63270ba804dd6337a8b0">DampingRatio</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a9f2ba932f90e63270ba804dd6337a8b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The damping ratio. 0 = no damping, 1 = critical damping.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html#a9f2ba932f90e63270ba804dd6337a8b0">More...</a><br /></td></tr>
<tr class="separator:a9f2ba932f90e63270ba804dd6337a8b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td colspan="2" onclick="javascript:toggleInherit('properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html">Joint</a></td></tr>
<tr class="memitem:addad4c6d854b8c10bcf693736126f9ee inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_world.html">World</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#addad4c6d854b8c10bcf693736126f9ee">World</a><code> [get]</code></td></tr>
<tr class="memdesc:addad4c6d854b8c10bcf693736126f9ee inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the parent <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_world.html" title="The world class manages all physics entities, dynamic simulation, and asynchronous queries.">World</a> of this joint. This is null if the joint is not attached.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#addad4c6d854b8c10bcf693736126f9ee">More...</a><br /></td></tr>
<tr class="separator:addad4c6d854b8c10bcf693736126f9ee inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a375b88e8e0673bf4d2e4ea24c7ec91cf inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">JointType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a375b88e8e0673bf4d2e4ea24c7ec91cf">JointType</a><code> [get, protected set]</code></td></tr>
<tr class="memdesc:a375b88e8e0673bf4d2e4ea24c7ec91cf inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the type of the joint.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a375b88e8e0673bf4d2e4ea24c7ec91cf">More...</a><br /></td></tr>
<tr class="separator:a375b88e8e0673bf4d2e4ea24c7ec91cf inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8c003a1fd3fb14b8a808303d67e3f5b inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_body.html">Body</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#af8c003a1fd3fb14b8a808303d67e3f5b">BodyA</a><code> [get, set]</code></td></tr>
<tr class="memdesc:af8c003a1fd3fb14b8a808303d67e3f5b inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the first body attached to this joint.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#af8c003a1fd3fb14b8a808303d67e3f5b">More...</a><br /></td></tr>
<tr class="separator:af8c003a1fd3fb14b8a808303d67e3f5b inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0b4d84d44f93476742419fb23f3c01d inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_body.html">Body</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#ad0b4d84d44f93476742419fb23f3c01d">BodyB</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ad0b4d84d44f93476742419fb23f3c01d inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the second body attached to this joint.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#ad0b4d84d44f93476742419fb23f3c01d">More...</a><br /></td></tr>
<tr class="separator:ad0b4d84d44f93476742419fb23f3c01d inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab448af58cedb44e032daeefd3295d26b inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#ab448af58cedb44e032daeefd3295d26b">WorldAnchorA</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ab448af58cedb44e032daeefd3295d26b inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the anchor point on bodyA in world coordinates. On some joints, this value indicate the anchor point within the world.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#ab448af58cedb44e032daeefd3295d26b">More...</a><br /></td></tr>
<tr class="separator:ab448af58cedb44e032daeefd3295d26b inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf4fd3f20ade1c978a7d7d07a5e9e7ba inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#adf4fd3f20ade1c978a7d7d07a5e9e7ba">WorldAnchorB</a><code> [get, set]</code></td></tr>
<tr class="memdesc:adf4fd3f20ade1c978a7d7d07a5e9e7ba inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the anchor point on bodyB in world coordinates. On some joints, this value indicate the anchor point within the world.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#adf4fd3f20ade1c978a7d7d07a5e9e7ba">More...</a><br /></td></tr>
<tr class="separator:adf4fd3f20ade1c978a7d7d07a5e9e7ba inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77e734c4babee723cc437bc218e2f288 inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a77e734c4babee723cc437bc218e2f288">CollideConnected</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a77e734c4babee723cc437bc218e2f288 inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set this flag to true if the attached bodies should collide.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a77e734c4babee723cc437bc218e2f288">More...</a><br /></td></tr>
<tr class="separator:a77e734c4babee723cc437bc218e2f288 inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5f05154e31ebc368d68c91039031523 inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#ac5f05154e31ebc368d68c91039031523">Breakpoint</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ac5f05154e31ebc368d68c91039031523 inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Breakpoint simply indicates the maximum Value the JointError can be before it breaks. The default value is float.MaxValue, which means it never breaks.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#ac5f05154e31ebc368d68c91039031523">More...</a><br /></td></tr>
<tr class="separator:ac5f05154e31ebc368d68c91039031523 inherit properties_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html">Joint</a></td></tr>
<tr class="memitem:a558f5c44426d0eb7abb82a65e8892d9a inherit pub_attribs_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a558f5c44426d0eb7abb82a65e8892d9a">Enabled</a> = true</td></tr>
<tr class="memdesc:a558f5c44426d0eb7abb82a65e8892d9a inherit pub_attribs_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate if this join is enabled or not. Disabling a joint means it is still in the simulation, but inactive.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a558f5c44426d0eb7abb82a65e8892d9a">More...</a><br /></td></tr>
<tr class="separator:a558f5c44426d0eb7abb82a65e8892d9a inherit pub_attribs_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b7f4dc326555ee4a2f96d52622475cd inherit pub_attribs_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a4b7f4dc326555ee4a2f96d52622475cd">Tag</a></td></tr>
<tr class="memdesc:a4b7f4dc326555ee4a2f96d52622475cd inherit pub_attribs_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the user data pointer.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a4b7f4dc326555ee4a2f96d52622475cd">More...</a><br /></td></tr>
<tr class="separator:a4b7f4dc326555ee4a2f96d52622475cd inherit pub_attribs_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html">Joint</a></td></tr>
<tr class="memitem:ab6ad917c93c524e7e95c88955052d12e inherit pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top"><a id="ab6ad917c93c524e7e95c88955052d12e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Joint</b> (<a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_body.html">Body</a> bodyA, <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_body.html">Body</a> bodyB)</td></tr>
<tr class="separator:ab6ad917c93c524e7e95c88955052d12e inherit pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ed184e088d1d9eafabd761fcf85b147 inherit pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a1ed184e088d1d9eafabd761fcf85b147">Joint</a> (<a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_body.html">Body</a> body)</td></tr>
<tr class="memdesc:a1ed184e088d1d9eafabd761fcf85b147 inherit pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for fixed joint  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a1ed184e088d1d9eafabd761fcf85b147">More...</a><br /></td></tr>
<tr class="separator:a1ed184e088d1d9eafabd761fcf85b147 inherit pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab93d501643113e1a7bbf98e082993792 inherit pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top"><a id="ab93d501643113e1a7bbf98e082993792"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>WakeBodies</b> ()</td></tr>
<tr class="separator:ab93d501643113e1a7bbf98e082993792 inherit pro_methods_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header events_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td colspan="2" onclick="javascript:toggleInherit('events_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint')"><img src="closed.png" alt="-"/>&#160;Events inherited from <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html">Joint</a></td></tr>
<tr class="memitem:aea15d567852879223509e956f3f75a1a inherit events_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memItemLeft" align="right" valign="top">Action&lt; <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html">Joint</a>, float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#aea15d567852879223509e956f3f75a1a">Broke</a></td></tr>
<tr class="memdesc:aea15d567852879223509e956f3f75a1a inherit events_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fires when the joint is broken.  <a href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#aea15d567852879223509e956f3f75a1a">More...</a><br /></td></tr>
<tr class="separator:aea15d567852879223509e956f3f75a1a inherit events_classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A mouse joint is used to make a point on a body track a specified world point. This a soft constraint with a maximum force. This allows the constraint to stretch and without applying huge forces. NOTE: this joint is not documented in the manual because it was developed to be used in the testbed. If you want to learn how to use the mouse joint, look at the testbed. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae8f3ac497907a3b49f3a048f7573f5c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8f3ac497907a3b49f3a048f7573f5c5">&#9670;&nbsp;</a></span>FixedMouseJoint()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html">FixedMouseJoint</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_body.html">Body</a>&#160;</td>
          <td class="paramname"><em>body</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a>&#160;</td>
          <td class="paramname"><em>worldAnchor</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This requires a world target point, tuning parameters, and the time step. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">body</td><td>The body.</td></tr>
    <tr><td class="paramname">worldAnchor</td><td>The target.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a655b5ba70f47995fbe17b62474d32ca7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a655b5ba70f47995fbe17b62474d32ca7">&#9670;&nbsp;</a></span>GetReactionForce()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override <a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a> GetReactionForce </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>invDt</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the reaction force on body at the joint anchor in Newtons. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">invDt</td><td>The inverse delta time.</td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#a488df9e4f355efa29dd7df62ee5863a1">Joint</a>.</p>

</div>
</div>
<a id="a86cd32ec6a920205da5cf3202ceefba5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86cd32ec6a920205da5cf3202ceefba5">&#9670;&nbsp;</a></span>GetReactionTorque()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override float GetReactionTorque </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>invDt</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the reaction torque on the body at the joint anchor in N*m. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">invDt</td><td>The inverse delta time.</td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_joint.html#abbd479f202d287c4d7627c055d47563a">Joint</a>.</p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a9f2ba932f90e63270ba804dd6337a8b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f2ba932f90e63270ba804dd6337a8b0">&#9670;&nbsp;</a></span>DampingRatio</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float DampingRatio</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The damping ratio. 0 = no damping, 1 = critical damping. </p>

</div>
</div>
<a id="a9d3c19e881c80a6596884ecb8da4a0f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d3c19e881c80a6596884ecb8da4a0f4">&#9670;&nbsp;</a></span>Frequency</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float Frequency</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The response speed. </p>

</div>
</div>
<a id="aea4a215e75a513da8aae15b39eb44afe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea4a215e75a513da8aae15b39eb44afe">&#9670;&nbsp;</a></span>LocalAnchorA</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structnkast_1_1_aether_1_1_physics2_d_1_1_common_1_1_vector2.html">Vector2</a> LocalAnchorA</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The local anchor point on BodyA </p>

</div>
</div>
<a id="aea6a8bd745d298d7f57f809ccc4edadb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea6a8bd745d298d7f57f809ccc4edadb">&#9670;&nbsp;</a></span>MaxForce</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float MaxForce</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The maximum constraint force that can be exerted to move the candidate body. Usually you will express as some multiple of the weight (multiplier * mass * gravity). </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Physics2D/Dynamics/Joints/FixedMouseJoint.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacenkast.html">nkast</a></li><li class="navelem"><a class="el" href="namespacenkast_1_1_aether.html">Aether</a></li><li class="navelem"><a class="el" href="namespacenkast_1_1_aether_1_1_physics2_d.html">Physics2D</a></li><li class="navelem"><a class="el" href="namespacenkast_1_1_aether_1_1_physics2_d_1_1_dynamics.html">Dynamics</a></li><li class="navelem"><a class="el" href="namespacenkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints.html">Joints</a></li><li class="navelem"><a class="el" href="classnkast_1_1_aether_1_1_physics2_d_1_1_dynamics_1_1_joints_1_1_fixed_mouse_joint.html">FixedMouseJoint</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>
